Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply some feedback on new docs #3842

Merged
merged 6 commits into from
Jan 14, 2025
Merged

Conversation

JessamyT
Copy link
Collaborator

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jan 11, 2025
Copy link
Member

@EshaMaharishi EshaMaharishi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for putting this up quickly! LGTM mod minor nits

I'm also sending an email to Eliot + Naomi to discuss using MicroRDK where appropriate rather than viam-micro-server

docs/operate/get-started/other-hardware/micro-module.md Outdated Show resolved Hide resolved
When a module initializes, it registers its {{< glossary_tooltip term_id="model" text="model or models" >}} and associated [APIs](/dev/reference/apis/) with `viam-server`, making the new model available for use.
`viam-server` manages the [dependencies](/operate/reference/viam-server/#dependency-management), [start-up](/operate/reference/viam-server/#start-up), [reconfiguration](/operate/reference/viam-server/#reconfiguration), [data management](/data-ai/capture-data/capture-sync/), and [shutdown](/operate/reference/viam-server/#shutdown) behavior of your modular resource.

For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes the micro-RDK and one or more modules onto your device.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes the micro-RDK and one or more modules onto your device.
For microcontrollers, you must flash a [firmware build of `viam-micro-server`](/operate/get-started/other-hardware/micro-module/) that includes MicroRDK and one or more modules onto your device.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is how we have it in a couple of other pages right now--I'm going to leave this as-is for now and we can always change later if there is a different agreed-upon styling

@viambot
Copy link
Member

viambot commented Jan 13, 2025

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3842

@JessamyT JessamyT merged commit bcd25cb into viamrobotics:main Jan 14, 2025
8 of 9 checks passed
@JessamyT JessamyT deleted the eshafeedback branch January 14, 2025 00:02
npentrel added a commit to npentrel/viam-docs that referenced this pull request Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants